FlowGroup Properties
An object defining properties for the FlowGroup class.
MessageOptions
Gets or sets the message options.
Type: IFlowMessageOptions
NotificationOptions
Gets or sets the push notification options.
ConflictStateEventId
Event ID for handling conflict states in the group.
Type: int
Key
A unique identifier for the workflow step.
Type: string
MailMessage
Gets the mail message associated with the message.
Type: Dictionary<string, string>
WorkflowCodeInstance
The workflow code instance associated with the flow object.
Type: IWorkflowCode
CachedDMObjects
The cached document management objects related to the flow object.
Type: IRuntimeDMObjects
DoNotSendRequestIfProcessed
Indicates whether a request should be avoided if already processed.
Type: bool
NotificationCaption
Gets the notification caption associated with the message.
Type: Dictionary<string, string>
Positions
Retrieves the positions resolved for the workflow group members.
Type: List<UserPosition>
EmptyGroupEventId
Specifies the event ID triggered when the group is empty.
Type: int
NotificationMessage
Gets the notification message associated with the message.
Type: Dictionary<string, string>
HideApporoverInHistory
Determines whether the approver's name is hidden in the workflow history.
Type: bool
AutoOpenApprovalOption
Specifies whether approvals should open automatically upon group interaction.
Type: int
IsCustomMailMessage
Gets or sets a value indicating whether the mail message is custom.
Type: bool
MailSubject
Gets the mail subject associated with the message.
Type: Dictionary<string, string>
GeolocationOptions
Geolocation options for tracking workflow-related activities.
Type: IFlowGeolocationOptions
EnableSendMail
Gets or sets a value indicating whether sending mail is enabled.
Type: bool
TypeCode
The type code associated with the flow object.
Type: WorkflowItemTypeCode
Accepted Values:
Name Value FlowComment -1 FlowStart 10 FlowEnd 11 FlowPosition 15 FlowAssign 21 FlowCompare 22 FlowOr 24 FlowAnd 25 FlowMail 26 FlowProfession 27 FlowDepartment 28 Variable 30 FlowScript 31 FlowNode 33 FlowGroup 37 FlowTimer 39 FlowTimerStarter 40 FlowTimerStopper 41 FlowApprovalCancellar 42 Pauser 44 SubFlowCall 51 SubFlowBegin 52 SubFlowEnd 53 FlowPushNotification 54 FlowDocument 56 FlowCreateDocument 57 FlowDocumentSynchronizer 58 FlowStarterPosition 59 FlowDocumentState 63 FlowUniqueIdCreator 65 FlowSetDocumentId 66 FlowDeleteDocument 67 FlowPDFExport 68 FlowXMLExport 69 FlowMailSender 75 FlowParallel 79 FlowContinue 80 FlowTrigger 81 FlowActionCreator 82 FlowDigitallySigning 83 FlowGptPrompt 84
Members
Holds the configuration for members within the group.
Type: FlowMembersOptions
EventsToCheck
List of event IDs that should be checked for the workflow group.
TimeoutHour
The number of hours before a timeout occurs.
Type: int
RequestIsNecessaryIfDocumentChanged
Specifies if a request is required when the document changes.
Type: bool
TimeoutDuration
The total timeout duration for the group.
Type: TimeSpan
Attachments
Gets the list of attachments associated with the message.
Type: IReadOnlyList<string>
WebNotificationOptions
Gets or sets the web notification options.
TableObjects
List of table objects relevant to the workflow group.
Type: List<MembersTableObjects>
TimeoutOptions
Defines the timeout settings for the group.
Type: IFlowTimeoutOptions
TimeoutDay
The number of days before a timeout occurs.
Type: int
Name
Name for the workflow step.
Type: string
DetailObjects
Detail objects within the workflow group.
Type: List<MembersDetailObjects>
CalculateUsingWorkingHours
Indicates whether working hours are considered for timeout calculations.
Type: bool
Users
Retrieves the users resolved for the workflow group members.
EnableOwnRequest
Specifies whether users can approve their own requests within this group.
Type: bool
Documents
List of documents associated with the workflow group.
Events
Read-only list of events associated with the workflow group.
Type: IReadOnlyList<IEvent>
EnablePushNotification
Gets or sets a value indicating whether push notification is enabled.
Type: bool
PositionGroups
Represents the position groups associated with the workflow group.
Type: MembersPositionGroups
CustomMailMessage
Gets the custom mail message associated with the message.
Type: Dictionary<string, string>
TimeoutMinute
The number of minutes before a timeout occurs.
Type: int
ShowInFlowHistory
Indicates whether this group should appear in the workflow history.
Type: bool
CalculateUsingHolidays
Determines whether holiday settings are considered in timeout calculations.
Type: bool
Caption
The caption dictionary representing localized captions for the flow object.
Type: Dictionary<string, string>